build: update release cadence - #89
Conversation
Laveesh Rohra (larohra)
left a comment
There was a problem hiding this comment.
Review Summary
Overall this is a reasonable release-cadence update, but the config-docs auto-generation piece has one critical dead-code bug that should be fixed before merge:
🔴 Critical
generate_config_reference.pyimports new*_DESCRIPTIONSdicts fromschema.py, but they're immediately shadowed by pre-existing local dict literals later in the same file — the import has zero effect on generated docs (verified empirically with a marker-string test). See inline comment for details and the fix path.
🟡 Suggestions
- The new
schema.pydescription dicts are also stale/incomplete relative to the local copies they're meant to replace (missingweb_request/workflowsentries) — worth reconciling now while fresh, since it'll block the eventual cleanup of the dead local dicts. docs/AUTO_GENERATION.mdnow tells contributors to editschema.pyfor descriptions, which is misleading until the above is actually fixed.versionPattern's default was narrowed to double-quotes-only, inconsistent with the template it calls (which still supports both quote styles) — likely fine today but worth confirming it's intentional.- Re: the cross-stage variable propagation (also flagged in the existing comment on the
Buildstage below) — it's not just boilerplate,build-artifacts.yml/publish-release.ymlgenuinely needlibraryVersionbefore checkout. ButResolveVersioncould be folded intoBumpVersion's job as its first step, dropping one stage's pool spin-up and trimming the repeatedstageDependenciesblocks from 3 copies to 2. See inline comment for specifics.
🟢 Looks good
- The new
trigger/pr: noneblock is a well-justified fix for unwanted default-branch pipeline triggers.
Happy to help with the fix for the dead-code issue if useful.
There was a problem hiding this comment.
Pull request overview
This PR updates the release pipeline to auto-trigger releases on src/** changes and auto-compute the next beta version when libraryVersion isn’t provided, while also relocating doc-generation field description metadata from the generator script into schema.py (so the schema remains the source of truth for enhanced field descriptions).
Changes:
- Add
src/**-scoped pipeline trigger + a newResolveVersionstage to compute the nextx.y.zb(n+1)version whenlibraryVersionis empty. - Move
*_DESCRIPTIONS/ defaults dictionaries out ofeng/scripts/generate_config_reference.pyintosrc/azure_functions_agents/config/schema.py. - Update documentation/process guidance to reflect where field description metadata lives.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
src/azure_functions_agents/config/schema.py |
Adds doc-generation description/default dictionaries alongside the schema models. |
eng/scripts/generate_config_reference.py |
Switches to reading description/default dictionaries from schema.py instead of defining them locally. |
eng/ci/library-release.yml |
Adds src/** trigger scoping and a ResolveVersion stage; wires resolved version into bump/build/release stages. |
docs/AUTO_GENERATION.md |
Updates guidance to edit enhanced field descriptions in schema.py. |
.github/skills/add-feature/SKILL.md |
Broadens wording about which docs under docs/ may need updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…s-runtime into hallvictoria/release-on-merge
Purpose
src/__init__.pyupdates - prevent circular releasesDoes this introduce a breaking change?
Pull Request Type
What kind of change does this Pull Request introduce?
How to Test
What to Check
Verify that the following are valid
Other Information